SAA-4082: Replace prison api locations group endpoint#2020
Merged
Mitchell D'silva (mitchell-dsilva) merged 4 commits intomainfrom Mar 20, 2026
Merged
Conversation
Mitchell D'silva (mitchell-dsilva)
requested a review
from a team
as a code owner
Copilot started reviewing on behalf of
Kristian Gregory (KristianGregor)
March 20, 2026 10:34
View session
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates “location groups” retrieval off the deprecated Prison API endpoint onto the Locations Inside Prison API, updating the client/service layer and moving corresponding WireMock stubs and fixtures.
Changes:
- Removed
getLocationGroups()fromPrisonApiClientand introduced a newgetLocationGroups()inLocationsInsidePrisonAPIClientusing/locations/prison/{prisonCode}/groups. - Replaced the default location-group service implementation from Prison API to Locations Inside Prison API.
- Updated WireMock servers/fixtures and adjusted unit/integration tests accordingly.
Reviewed changes
Copilot reviewed 13 out of 16 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/main/kotlin/.../client/prisonapi/api/PrisonApiClient.kt | Removes deprecated Prison API location-groups call. |
| src/main/kotlin/.../client/locationsinsideprison/api/LocationsInsidePrisonAPIClient.kt | Adds Locations Inside Prison API location-groups call. |
| src/main/kotlin/.../service/LocationGroupFromPrisonApiService.kt | Removes old default service that called Prison API. |
| src/main/kotlin/.../service/LocationGroupFromLocationsInsidePrisonApiService.kt | Adds new default service that calls Locations Inside Prison API. |
| src/main/kotlin/.../service/LocationGroupService.kt | Renames parameters to prisonCode for clarity/consistency. |
| src/main/kotlin/.../service/LocationGroupServiceSelector.kt | Routes selection using prisonCode terminology. |
| src/main/kotlin/.../service/LocationGroupFromPropertiesService.kt | Updates parameter names, but leaves some agencyId terminology in docs/messages. |
| src/test/kotlin/.../integration/wiremock/PrisonApiMockServer.kt | Removes location-groups stubs from Prison API mock. |
| src/test/kotlin/.../integration/wiremock/LocationsInsidePrisonApiMockServer.kt | Adds location-groups stubs for Locations Inside Prison API mock. |
| src/test/resources/__files/locationsinsideprisonapi/*.json | Adds new WireMock fixtures for location-groups responses/errors. |
| src/test/kotlin/.../integration/LocationIntegrationTest.kt | Updates integration test to stub and assert against Locations Inside Prison API. |
| src/test/kotlin/.../client/prisonapi/api/PrisonApiClientTest.kt | Removes Prison API client tests for deprecated endpoint. |
| src/test/kotlin/.../client/locationsinsideprison/api/LocationsInsidePrisonAPIClientTest.kt | Adds client tests for new location-groups endpoint (currently contains a suspend/assertThrows issue). |
| src/test/kotlin/.../service/LocationGroupFromLocationsInsidePrisonApiServiceTest.kt | Adds service test for new client call (currently contains a suspend verification issue). |
Comments suppressed due to low confidence (1)
src/test/kotlin/uk/gov/justice/digital/hmpps/hmppsactivitiesmanagementapi/service/LocationGroupFromLocationsInsidePrisonApiServiceTest.kt:52
getLocationGroupsonLocationsInsidePrisonAPIClientis a suspend function. Usingverify(locationsInsidePrisonApiClient).getLocationGroups("LEI")will include the implicitContinuationparameter and typically won't verify correctly. Use Mockito-Kotlin'sverifyBlocking { ... }for suspend functions instead (as done elsewhere in the test suite).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
...ice/digital/hmpps/hmppsactivitiesmanagementapi/service/LocationGroupFromPropertiesService.kt
Show resolved
Hide resolved
...ice/digital/hmpps/hmppsactivitiesmanagementapi/service/LocationGroupFromPropertiesService.kt
Outdated
Show resolved
Hide resolved
...tivitiesmanagementapi/client/locationsinsideprison/api/LocationsInsidePrisonAPIClientTest.kt
Show resolved
Hide resolved
Kristian Gregory (KristianGregor)
previously approved these changes
Mar 20, 2026
Copilot started reviewing on behalf of
Mitchell D'silva (mitchell-dsilva)
March 20, 2026 13:06
View session
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 14 out of 17 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
...mpps/hmppsactivitiesmanagementapi/integration/wiremock/LocationsInsidePrisonApiMockServer.kt
Show resolved
Hide resolved
Kristian Gregory (KristianGregor)
approved these changes
Mar 20, 2026
Mitchell D'silva (mitchell-dsilva)
deleted the
SAA-4082-replace-prisoner-api-locations-group-endpoint
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Work Done:
PrisonApiClientusing the deprecated endpoint ("/api/agencies/{agencyId}/locations/groups") from PrisonApi has been removed and a new getLocationGroups() has been added toLocationsInsidePrisonAPIClientfor the new endpoint ("/locations/prison/{prisonCode}/groups") in LocationsInsidePrisonApi.PrisonApiMockServerand moved toLocationsInsidePrisonApiMockServer.Ticket: SAA-4082